Virtual Infrastructure

Adds virtual infrastructure to the inventory.

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/virtual

Supported Requests

Hypervisors

Method URL Input Return
DELETE https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor} URL Parameters  
GET https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors   Hypervisors[]
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor}   Configuration information for the specified hypervisor.
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor}/images/{id of image}   Configuration information for the specified virtual image.

https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor}/images

URL Parameters

VirtualImages[]
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id of hypervisor}/images/usedby    
POST

https://<consoleFQDN:port>/st/console/api/v1.0/virtual

POST Request Body  
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id}/refresh    
PATCH https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/{id} PATCH Request Body  

VCenters

Method URL Input Return
DELETE https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id of vcenter} URL Parameters  
GET https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters   VCenterServers[]
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id of vcenter}   Configuration information for the specified vCenter Server.
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id of vcenter}/hypervisors   Hypervisors[]
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id of vcenter}/usedby    
POST https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters POST Request Body  
https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id}/refresh    
PATCH https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters/{id} PATCH Request Body  

Input Models

Name Type Description

count

Integer

Provide the count of items to return. The default is 10 and the maximum value is 1000.

forcedelete

Boolean

This parameter applies only to DELETE requests.

Specifies if the hypervisor or vCenter should be deleted even if it is being used within a machine group.

start

Integer

Sets the starting point. The items are sorted by their unique identifier and the starting point is the index into that sorted list.
Name Required? Type Default Value Description

certIficateThumbprint

No

String

None

The server's hexadecimal encoded certificate thumbprint. It is used to verify the server the first time you connect to it.

credentialId

Yes

Guid

None

The credential ID.

name

Yes

String

None

The name of the vCenter.

port

No

Integer

443

The port.
Name Required? Type Default Value Description

certIficateThumbprint

No

String

None

The server's certificate thumbprint. It is used to verify the server the first time you connect to it.

Example with Sample Response

Find all VCenter servers

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/virtual/vcenters

Sample Response

Copy 
{
    "count": 1,
    "value": [
        {
            "certificateThumbprint": "A22AD02F85CACAE70900F0F24158DA7F7CEC1556",
            "credentialId": "daf645ca-a22f-4ffc-a186-32a620c8b67b",
            "id": 1,
            "links": {
                "self": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/virtual/vcenters/1"
                },
                "hypervisors": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/virtual/vcenters/1/hypervisors"
                },
                "usedby": {
                    "href": "https:/device-name.example.com:3121/st/console/api/v1.0/virtual/vcenters/1/usedby"
                }
            },
            "managedHypervisors": [
                "https://device-name.example.com:3121/st/console/api/v1.0/virtual/hypervisors/1",
                "https://device-name.example.com:3121/st/console/api/v1.0/virtual/hypervisors/2",
                "https://device-name.example.com:3121/st/console/api/v1.0/virtual/hypervisors/3",
                "https://device-name.example.com:3121/st/console/api/v1.0/virtual/hypervisors/4",
                "https://device-name.example.com:3121/st/console/api/v1.0/virtual/hypervisors/5",
                "https://device-name.example.com:3121/st/console/api/v1.0/virtual/hypervisors/6",
                "https://device-name.example.com:3121/st/console/api/v1.0/virtual/hypervisors/7",
                "https://device-name.example.com:3121/st/console/api/v1.0/virtual/hypervisors/8"
            ],
            "name": "sample.example.com",
            "port": 443
        }
    ]
}

Other Request Examples

DELETE Request

https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/10?forcedelete=true

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/virtual/hypervisors/1/images?count=10

POST Request

Copy 
https://<consoleFQDN:port>/st/console/api/v1.0/virtual

{
"Name": "192.168.106.128",
"CredentialId": "01234567-89AB-CDEF-0123-456789ABCDEF"
}

Output Models

Name Type Description

certificateThumbprint

String

The server's hexadecimal encoded certificate thumbprint. This was provided using the REST API or accepted via the user interface.

credentialId

Guid

The credential ID.

id

Integer

The ID.

links

Links

Shows the related URLs.

managedHypervisors

String

The list of all managed hypervisors.

name

String

The item name.

port

Integer

The port.
Name Type Description

hostName

String

The host name.

id

Integer

The unique identifier of the item.

inventoryPath

String

The inventory path.

ipAddress

IPAddress

The IP address.

lastKnownPowerState

VirtualMachineState

The last known power state.

links

Links

Shows the related URLs.

name

String

The item name.

runningStatus

ToolsRunningStatus

The VMware tools running status.

versionStatus

ToolsVersionStatus

The VMware tools version status.
Name Type Description

certificateThumbprint

String

The server's hexadecimal encoded certificate thumbprint. This was provided using the REST API or accepted via the user interface.

credentialId

Guid

The credential ID.

hostSystemName

String

The host system name.

id

Integer

The ID.

ipAddress

String

The IP address.

isInMaintenanceMode

Boolean

Is in maintenance mode.

links

Links

Shows the related URLs.

name

String

The item name.

port

Integer

The port number.

vCenterServerId

Integer

The VCenter Server ID.
Name Type Description

adminCredentialId

Guid

The ID of the associated administrative credential (if any).

category

DiscoveryFilterType

The type of filter or machine group item.

id

Integer

The unique identifier of the item.

inventoryPath

String

The inventory path.

links

Links

Shows the related URLs.

note

String

A user-specified note or description.

serverName

String

The server name.
Name Type Description

name

String

Gets the name of the item that is using this hypervisor or vCenter.

usageType

Enum

The type of component using this hypervisor or vCenter.
  • PoweredOff
  • PoweredOn
  • Suspended
  • Unknown
  • GuestToolsNotRunning
  • GuestToolsRunning
  • GuestToolsExecutingScripts
  • Blacklisted
  • Current
  • NeedUpgrade
  • NotInstalled
  • SupportedNew
  • SupportedOld
  • TooNew
  • TooOld
  • Unmanaged
  • Unknown